| MFMI_MT700716CA Registry Request Wrapper - Device Initiated With Role Payload |
Derived from RMIM: MFMI_RM700716CA and HMD: MFMI_HD700716CA |
||||||||
| ControlActEvent |
Design Comments: Identifies the action that resulted in this message being sent. UsageNotes: There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Rationale: Key to understanding what action a message represents. |
||||||||
| classCode [1..1] (M) ControlAct (CS) {CNE:C:ActClass:CACT, fixed value= "CACT"} |
|||||||||
| moodCode [1..1] (M) ControlAct (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| id [1..1] (M) ControlAct (II.BUS) |
Design Comments: A unique identifier for this particular event assigned by the system in which the event occurred. UsageNotes: Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Rationale: Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. |
||||||||
| code [1..1] (M) ControlAct (CV) {CNE:D:HL7TriggerEventCode} |
Design Comments: Identifies the trigger event that occurred. Rationale: This is mandatory because it is essential to understanding the meaning of the event. |
||||||||
| statusCode [1..1] (M) ControlAct (CS) {CNE:C:ActStatus:completed, fixed value= "completed"} |
Design Comments: Describes the status of the control act, which is always complete (it happened). Rationale: Required for completeness of specification. |
||||||||
| effectiveTime [0..1] ControlAct (IVL<TS.FULLDATEWITHTIME>) |
Design Comments: Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. Rationale: The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events such as 'suspend', an intended end date may also be indicated. |
||||||||
| reasonCode [0..1] ControlAct (CV) {CWE:D:ControlActReason} |
Design Comments: Identifies why this specific message interaction (e.g. query, activation request, modification request) occurred. UsageNotes: The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Rationale: Allows identifying a reason for a specific action, such as 'reason for hold' or 'reason for accessing information'. |
||||||||
| languageCode [0..1] ControlAct (CE) {CNE:D:HumanLanguage} |
|||||||||
| subject [1..1] (Subject2) |
Design Comments: Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. UsageNotes: If there are multiple subject items, the changes to all of them must be either accepted or rejected as a single action. I.e. One trigger event = 1 unit of work. Rationale: Provides information about the thing being created, modified or removed. |
||||||||
| subjectOf [0..50] (Subject) |
Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action. Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed. |
||||||||
| Subject2 [Constraint: " On ‘creation’ interactions (where the state transition is null->active), this must be true otherwise it must be false. "] |
Design Comments: Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. UsageNotes: If there are multiple subject items, the changes to all of them must be either accepted or rejected as a single action. I.e. One trigger event = 1 unit of work. Rationale: Provides information about the thing being created, modified or removed. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:ON, fixed value= "ON"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL) |
Design Comments: Indicates whether or not objects of the trigger event are to be cascaded to the payload. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the regsitrationRequest act) according to the subjectOf.contextControlCode (AP = propogate to the reg request and add to any subject(s) (issues) already present in the payload). Rationale: Cascading of trigger event objects allows different messages to employ consistent and common objects. Attribute is mandatory to ensure that cascading will be specified one way or another. |
||||||||
| registrationRequest [1..1] (RegistrationRequest) |
Design Comments: This class contains information relevant to the registration of the payload item(s) into the Master File or Registry. This message is a request to register. Rationale: The RegistrationProcess act is the focal act of the message and therefore is mandatory |
||||||||
| RegistrationRequest |
Design Comments: This class contains information relevant to the registration of the payload item(s) into the Master File or Registry. This message is a request to register. Rationale: The RegistrationProcess act is the focal act of the message and therefore is mandatory |
||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:REG, fixed value= "REG"} |
|||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:RQO, fixed value= "RQO"} |
|||||||||
| statusCode [1..1] (M) Act (CS) {CNE:C:ActStatus:active, fixed value= "active"} |
|||||||||
| subject [1..1] (Subject4) |
Design Comments: Commonly called the Payload stub. Any interaction that uses this ControlAct Wrapper will replace this class with a Role-based domain Message Type Rationale: Defines the content of the registration and is therefore mandatory. |
||||||||
| custodian [1..1] (Custodian) |
Design Comments: This indicates the EHR repository the record is stored in. Rationale: Different repositories may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
||||||||
| replacementOf [0..10] (ReplacementOf) |
Design Comments: Associates a new registration which is intended to replace a registration received prior to this message. Rationale: Supports this message "replacing" a prior registration with a current regsitration (merges). |
||||||||
| Subject4 |
Design Comments: Commonly called the Payload stub. Any interaction that uses this ControlAct Wrapper will replace this class with a Role-based domain Message Type Rationale: Defines the content of the registration and is therefore mandatory. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| registeredRole [1..1] (Stub "RegisteredRole") | |||||||||
| Custodian |
Design Comments: This indicates the EHR repository the record is stored in. Rationale: Different repositories may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:CST, fixed value= "CST"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| assignedDevice [1..1] (R_AssignedDeviceRepository) | |||||||||
| ReplacementOf |
Design Comments: Associates a new registration which is intended to replace a registration received prior to this message. Rationale: Supports this message "replacing" a prior registration with a current regsitration (merges). |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:RPLC, fixed value= "RPLC"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| priorRegistration [1..1] (PriorRegistration) |
Design Comments: This class describes the registration of a client, provider, location, etc. in the past. Rationale: Used to associate (replace) a current registration with a regsitration already received (supports merges). |
||||||||
| PriorRegistration |
Design Comments: This class describes the registration of a client, provider, location, etc. in the past. Rationale: Used to associate (replace) a current registration with a regsitration already received (supports merges). |
||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:REG, fixed value= "REG"} |
|||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| statusCode [1..1] (M) Act (CS) {CNE:C:ActStatus:obsolete, fixed value= "obsolete"} |
|||||||||
| subject [1..1] (Subject5) | |||||||||
| Subject5 | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| priorRegisteredRole [1..1] (PriorRegisteredRole) |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| PriorRegisteredRole |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:ROL, fixed value= "ROL"} |
|||||||||
| id [1..1] (M) Role (II.BUS) |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| Subject |
Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action. Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| issueEvent [1..1] (A_IssueEventManaged-basic) | |||||||||